The ExportClient object contains the following methods:
The GetParams method retrieves the most recently saved parameters as an XML.
GetParams() As String
Example
The following example retrieves the parameters saved in Setup and saves them to a file.
|
Sub Dim fso Set fso = CreateObject("Scripting.FileSystemObject")
Const strFileName = "C:\CxExport_settings.xml"
' ------Read parameters from file------ Dim strParams, fileParams Set fileParams = fso.OpenTextFile(strFileName, 1, True)
On Error Resume Next strParams = fileParams.ReadAll fileParams.Close MsgBox strParams
' ------Set initial export parameters------ If Len(strParams) > 0 Then ExportClient.SetParams(strParams) End If
' ------Launch setup dialog, initialized with parameters------ ExportClient.Setup()
' ------Get new parameters and save to file------ strParams = ExportClient.GetParams()
MsgBox strParams
Set fileParams = fso.OpenTextFile(strFileName, 2, True) fileParams.WriteLine(strParams) fileParams.Close
' ------Do the actual export------ ExportClient.Update() End Sub |
The SetParams method sets the export parameters as an XML string.
SetParams(strSetup As String)
| Parameter | Required | Description |
|---|---|---|
| strSetup | Yes | An XML string representing the parameters to set. |
Example
The following example reads and sets export parameters from a file.
|
Sub Dim fso Set fso = CreateObject("Scripting.FileSystemObject")
Const strFileName = "C:\CxExport_settings.xml"
' ------Read parameters from file------ Dim strParams, fileParams Set fileParams = fso.OpenTextFile(strFileName, 1, True)
On Error Resume Next strParams = fileParams.ReadAll fileParams.Close MsgBox strParams
' ------Set initial export parameters------ If Len(strParams) > 0 Then ExportClient.SetParams(strParams) End If
' ------Launch setup dialog, initialized with parameters------ ExportClient.Setup()
' ------Get new parameters and save to file------ strParams = ExportClient.GetParams() MsgBox strParams
Set fileParams = fso.OpenTextFile(strFileName, 2, True) fileParams.WriteLine(strParams) fileParams.Close
' ------Do the actual export------ ExportClient.Update() End Sub |
The Setup method launches a Setup dialog box, used to configure export parameters.
Setup() As Boolean
This method returns True if the export parameters were modified, otherwise False.
Example
The following example launches a Setup dialog box before performing an export.
|
Sub Dim fso Set fso = CreateObject("Scripting.FileSystemObject")
Const strFileName = "C:\CxExport_settings.xml"
' ------Read parameters from file------ Dim strParams, fileParams Set fileParams = fso.OpenTextFile(strFileName, 1, True)
On Error Resume Next strParams = fileParams.ReadAll fileParams.Close MsgBox strParams
' ------Set initial export parameters------ If Len(strParams) > 0 Then ExportClient.SetParams(strParams) End If
' ------Launch setup dialog, initialized with parameters------ ExportClient.Setup()
' ------Get new parameters and save to file------ strParams = ExportClient.GetParams() MsgBox strParams
Set fileParams = fso.OpenTextFile(strFileName, 2, True) fileParams.WriteLine(strParams) fileParams.Close
' ------Do the actual export------ ExportClient.Update() End Sub |
The Update method exports data according to parameters set using SetParams or Setup.
Update() As String
This method returns the name of the file to which the data was exported.
Example
The following example performs an export after prompting the user for parameters.
|
Sub Dim fso Set fso = CreateObject("Scripting.FileSystemObject")
Const strFileName = "C:\CxExport_settings.xml"
' ------Read parameters from file------ Dim strParams, fileParams Set fileParams = fso.OpenTextFile(strFileName, 1, True)
On Error Resume Next strParams = fileParams.ReadAll fileParams.Close MsgBox strParams
' ------Set initial export parameters------ If Len(strParams) > 0 Then ExportClient.SetParams(strParams) End If
' ------Launch setup dialog, initialized with parameters------ ExportClient.Setup()
' ------Get new parameters and save to file------ strParams = ExportClient.GetParams() MsgBox strParams
Set fileParams = fso.OpenTextFile(strFileName, 2, True) fileParams.WriteLine(strParams) fileParams.Close
' ------Do the actual export------ ExportClient.Update() End Sub |
|
|
|
